# Input

The `<Input>` component is used in a form in order to retrieve input from the user.

## Import

```jsx
import { Input, InputField } from 'bumbag-native'
```

## Usage

```live
###tab=Default,type=jsx-live
<Input placeholder="Enter your name here..." />###

###tab=Filled,type=jsx-live
<Input placeholder="Enter your name here..." variant="filled" />###

###tab=Borderless,type=jsx-live
<Input placeholder="Enter your name here..." variant="borderless" />###

###tab=Underline,type=jsx-live
<Input placeholder="Enter your name here..." variant="underline" />###
```

### Labels

```live
###tab=Default,type=jsx-live
<Input label="Username" />###

###tab=Borderless,type=jsx-live
<Input label="Username" variant="borderless" />###

###tab=Underline,type=jsx-live
<Input label="Username" variant="underline" />###
```

### Fields

You can also use the `<InputField>` component, which internally has a [FieldWrapper](/native/form/field-wrapper) to wrap form controls such as labels, hint text and validation text.

It accepts a combination of [Input props](/native/form/input/#props) and [FieldWrapper props](/native/form/field-wrapper/#props).

```live
###tab=Default,type=jsx-live
<InputField label="Username" placeholder="Enter your name here..." />###

###tab=Borderless,type=jsx-live
<InputField label="Username" placeholder="Enter your name here..." variant="borderless" />###

###tab=Underline,type=jsx-live
<InputField label="Username" placeholder="Enter your name here..." variant="underline" />###
```

### Default values

For uncontrolled inputs, set a default value using the `defaultValue` prop.

```jsx-live
<Input defaultValue="Bumbags rock!" />
```

### Disabled

Make the input disabled with the `disabled` prop.

```live
###tab=Default,type=jsx-live
<Input disabled label="Username" />###

###tab=Borderless,type=jsx-live
<Input disabled label="Username" variant="borderless" />###

###tab=Underline,type=jsx-live
<Input disabled label="Username" variant="underline" />###
```

### Sizes

An input can come in different sizes - `small`, `medium`, `large`, or the default.

```live
###tab=Default,type=jsx-live
<Stack spacing="major-2">
  <Input label="Username" size="small" />
  <Input label="Username" />
  <Input label="Username" size="medium" />
  <Input label="Username" size="large" />
</Stack>###

###tab=Borderless,type=jsx-live
<Stack spacing="major-2">
  <Input label="Username" size="small" variant="borderless" />
  <Input label="Username" variant="borderless" />
  <Input label="Username" size="medium" variant="borderless" />
  <Input label="Username" size="large" variant="borderless" />
</Stack>###

###tab=Underline,type=jsx-live
<Stack spacing="major-2">
  <Input label="Username" size="small" variant="underline" />
  <Input label="Username" variant="underline" />
  <Input label="Username" size="medium" variant="underline" />
  <Input label="Username" size="large" variant="underline" />
</Stack>###
```

### Colors

#### Input colors

```live
###tab=Default,type=jsx-live
<Stack spacing="major-2">
  <Input palette="primary" label="Username" />
  <Input palette="secondary" label="Username" />
  <Input palette="danger" label="Username" />
  <Input palette="success" label="Username" />
  <Input palette="warning" label="Username" />
</Stack>###

###tab=Borderless,type=jsx-live
<Stack spacing="major-2">
  <Input palette="primary" label="Username" variant="borderless" />
  <Input palette="secondary" label="Username" variant="borderless" />
  <Input palette="danger" label="Username" variant="borderless" />
  <Input palette="success" label="Username" variant="borderless" />
  <Input palette="warning" label="Username" variant="borderless" />
</Stack>###

###tab=Underline,type=jsx-live
<Stack spacing="major-2">
  <Input palette="primary" label="Username" variant="underline" />
  <Input palette="secondary" label="Username" variant="underline" />
  <Input palette="danger" label="Username" variant="underline" />
  <Input palette="success" label="Username" variant="underline" />
  <Input palette="warning" label="Username" variant="underline" />
</Stack>###
```

#### Placeholder colors

```live
###tab=Default,type=jsx-live
<Stack spacing="major-2">
  <Input placeholderTextColor="primary" label="Username" />
  <Input placeholderTextColor="secondary" label="Username" />
  <Input placeholderTextColor="danger" label="Username" />
  <Input placeholderTextColor="success" label="Username" />
  <Input placeholderTextColor="warning" label="Username" />
</Stack>###

###tab=Borderless,type=jsx-live
<Stack spacing="major-2">
  <Input placeholderTextColor="primary" label="Username" variant="borderless" />
  <Input placeholderTextColor="secondary" label="Username" variant="borderless" />
  <Input placeholderTextColor="danger" label="Username" variant="borderless" />
  <Input placeholderTextColor="success" label="Username" variant="borderless" />
  <Input placeholderTextColor="warning" label="Username" variant="borderless" />
</Stack>###

###tab=Underline,type=jsx-live
<Stack spacing="major-2">
  <Input placeholderTextColor="primary" label="Username" variant="underline" />
  <Input placeholderTextColor="secondary" label="Username" variant="underline" />
  <Input placeholderTextColor="danger" label="Username" variant="underline" />
  <Input placeholderTextColor="success" label="Username" variant="underline" />
  <Input placeholderTextColor="warning" label="Username" variant="underline" />
</Stack>###
```

#### Label colors

```live
###tab=Default,type=jsx-live
<Stack spacing="major-2">
  <Input labelTextColor="primary" label="Username" />
  <Input labelTextColor="secondary" label="Username" />
  <Input labelTextColor="danger" label="Username" />
  <Input labelTextColor="success" label="Username" />
  <Input labelTextColor="warning" label="Username" />
</Stack>###

###tab=Borderless,type=jsx-live
<Stack spacing="major-2">
  <Input labelTextColor="primary" label="Username" variant="borderless" />
  <Input labelTextColor="secondary" label="Username" variant="borderless" />
  <Input labelTextColor="danger" label="Username" variant="borderless" />
  <Input labelTextColor="success" label="Username" variant="borderless" />
  <Input labelTextColor="warning" label="Username" variant="borderless" />
</Stack>###

###tab=Underline,type=jsx-live
<Stack spacing="major-2">
  <Input labelTextColor="primary" label="Username" variant="underline" />
  <Input labelTextColor="secondary" label="Username" variant="underline" />
  <Input labelTextColor="danger" label="Username" variant="underline" />
  <Input labelTextColor="success" label="Username" variant="underline" />
  <Input labelTextColor="warning" label="Username" variant="underline" />
</Stack>###
```

### States

```live
###tab=Default,type=jsx-live
<Stack spacing="major-2">
  <Input state="danger" label="Username" defaultValue="Invalid" />
  <Input state="success" label="Username" defaultValue="Invalid" />
  <Input state="warning" label="Username" defaultValue="Invalid" />
</Stack>###

###tab=Borderless,type=jsx-live
<Stack spacing="major-2">
  <Input state="danger" label="Username" defaultValue="Invalid" variant="borderless" />
  <Input state="success" label="Username" defaultValue="Invalid" variant="borderless" />
  <Input state="warning" label="Username" defaultValue="Invalid" variant="borderless" />
</Stack>###

###tab=Underline,type=jsx-live
<Stack spacing="major-2">
  <Input state="danger" label="Username" defaultValue="Invalid" variant="underline" />
  <Input state="success" label="Username" defaultValue="Invalid" variant="underline" />
  <Input state="warning" label="Username" defaultValue="Invalid" variant="underline" />
</Stack>###
```

### Icons

```live
###tab=Default,type=jsx-live
<Stack spacing="major-2">
  <Input
    iconBefore="solid-search"
    label="Username"
  />
  <Input
    iconAfter="solid-search"
    label="Username"
  />
</Stack>###

###tab=Borderless,type=jsx-live
<Stack spacing="major-2">
  <Input
    iconBefore="solid-search"
    label="Username"
    variant="borderless"
  />
  <Input
    iconAfter="solid-search"
    label="Username"
    variant="borderless"
  />
</Stack>###

###tab=Underline,type=jsx-live
<Stack spacing="major-2">
  <Input
    iconBefore="solid-search"
    label="Username"
    variant="underline"
  />
  <Input
    iconAfter="solid-search"
    label="Username"
    variant="underline"
  />
</Stack>###
```

### Addons

```jsx-live
<Group>
  <Input flex="1" label="Username" />
  <Button>Send</Button>
</Group>
```

### Controlled input

```function-live
function Example() {
  const [value, setValue] = React.useState('');
  return <Input onChangeText={setValue} value={value} />
}
```

## Props

### Input Props

<!-- Automatically generated -->

**<Code fontSize="150" marginRight="major-1">accessibilityLabelledBy</Code>** <Code fontSize="100" palette="primary">string</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">iconAfter</Code>** <Code fontSize="100" palette="primary">string</Code> 

Icon to place before the input.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">iconAfterProps</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`{
  top?: any;
  right?: any;
  bottom?: any;
  left?: any;
  color?: "default" | "primary" | "secondary" | "success" | "danger" | "warning" | (string & {
    ) | ({
      [key: string]: Flexible<"default" | "primary" | "secondary" | "success" | "danger" | "warning", strin
    } & string);
    ... 459 more ...;
    useOriginalFill?: boolean
  }`}
</Code>

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">iconBefore</Code>** <Code fontSize="100" palette="primary">string</Code> 

Icon to place after the input.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">iconBeforeProps</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`{
  top?: any;
  right?: any;
  bottom?: any;
  left?: any;
  color?: "default" | "primary" | "secondary" | "success" | "danger" | "warning" | (string & {
    ) | ({
      [key: string]: Flexible<"default" | "primary" | "secondary" | "success" | "danger" | "warning", strin
    } & string);
    ... 459 more ...;
    useOriginalFill?: boolean
  }`}
</Code>

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">inputProps</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`{
  top?: any;
  right?: any;
  bottom?: any;
  left?: any;
  color?: Flexible<Flexible<"default" | "primary" | "secondary" | "success" | "danger" | "warning", string>, string | number | {
    [key: string]: Flexible<"default" | ... 4 more ... | "warning", string>
  }>;
  ... 522 more ...;
  size?: Flexible<...>;
}`}
</Code>

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">inputRef</Code>** <Code fontSize="100" palette="primary">((instance: any) =&#62; void) | RefObject&#60;any&#62;</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">label</Code>** <Code fontSize="100" palette="primary">string</Code> 

Label of the input.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">labelTextColor</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"default"
  | "primary"
  | "secondary"
  | "success"
  | "danger"
  | "warning"
  | (string & {})`}
</Code>

Label color of the input. Can be any color in your palette.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">labelProps</Code>** <Code fontSize="100" palette="primary">any</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">palette</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"default"
  | "primary"
  | "secondary"
  | "success"
  | "danger"
  | "warning"
  | (string & {})`}
</Code>

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">placeholderTextColor</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"default"
  | "primary"
  | "secondary"
  | "success"
  | "danger"
  | "warning"
  | (string & {})`}
</Code>

Placeholder color of the input. Can be any color in your palette.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">state</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"default"
  | "primary"
  | "secondary"
  | "success"
  | "danger"
  | "warning"
  | (string & {})`}
</Code>

State of the input. Can be any color in your palette.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">size</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"default"
  | (string & {})
  | "small"
  | "medium"
  | "large"`}
</Code>

Alters the size of the input. Can be "small", "medium" or "large"

<Divider marginTop="major-2" marginBottom="major-2" />

<details><Box use="summary" marginBottom="major-2">Inherits <strong><a href="https://reactnative.dev/docs/textinput">React Native's <code>TextInput</code></a></strong> props</Box>

**<Code fontSize="150" marginRight="major-1">allowFontScaling</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

Specifies whether fonts should scale to respect Text Size accessibility settings.
The default is `true`.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">autoCapitalize</Code>** <Code fontSize="100" palette="primary">&#34;none&#34; | &#34;sentences&#34; | &#34;words&#34; | &#34;characters&#34;</Code> 

Can tell TextInput to automatically capitalize certain characters.
      characters: all characters,
      words: first letter of each word
      sentences: first letter of each sentence (default)
      none: don't auto capitalize anything

https://reactnative.dev/docs/textinput#autocapitalize

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">autoCorrect</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If false, disables auto-correct.
The default value is true.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">autoFocus</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, focuses the input on componentDidMount.
The default value is false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">blurOnSubmit</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, the text field will blur when submitted.
The default value is true.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">caretHidden</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, caret is hidden. The default value is false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">contextMenuHidden</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, context menu is hidden. The default value is false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">defaultValue</Code>** <Code fontSize="100" palette="primary">string</Code> 

Provides an initial value that will change when the user starts typing.
Useful for simple use-cases where you don't want to deal with listening to events
and updating the value prop to keep the controlled state in sync.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">editable</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If false, text is not editable. The default value is true.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">keyboardType</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"default"
  | "url"
  | "numeric"
  | "email-address"
  | "phone-pad"
  | "number-pad"
  | "decimal-pad"
  | "visible-password"
  | "ascii-capable"
  | "numbers-and-punctuation"
  | "name-phone-pad"
  | "twitter"
  | "web-search"`}
</Code>

enum("default", 'numeric', 'email-address', "ascii-capable", 'numbers-and-punctuation', 'url', 'number-pad', 'phone-pad', 'name-phone-pad',
'decimal-pad', 'twitter', 'web-search', 'visible-password')
Determines which keyboard to open, e.g.numeric.
The following values work across platforms: - default - numeric - email-address - phone-pad
The following values work on iOS: - ascii-capable - numbers-and-punctuation - url - number-pad - name-phone-pad - decimal-pad - twitter - web-search
The following values work on Android: - visible-password

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">maxLength</Code>** <Code fontSize="100" palette="primary">number</Code> 

Limits the maximum number of characters that can be entered.
Use this instead of implementing the logic in JS to avoid flicker.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">multiline</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, the text input can be multiple lines. The default value is false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onBlur</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputFocusEventData>) => void`}
</Code>

Callback that is called when the text input is blurred

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onChange</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputChangeEventData>) => void`}
</Code>

Callback that is called when the text input's text changes.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onChangeText</Code>** <Code fontSize="100" palette="primary">(text: string) =&#62; void</Code> 

Callback that is called when the text input's text changes.
Changed text is passed as an argument to the callback handler.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onContentSizeChange</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputContentSizeChangeEventData>) => void`}
</Code>

Callback that is called when the text input's content size changes.
This will be called with
`{ nativeEvent: { contentSize: { width, height } } }`.

Only called for multiline text inputs.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onEndEditing</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputEndEditingEventData>) => void`}
</Code>

Callback that is called when text input ends.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onFocus</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputFocusEventData>) => void`}
</Code>

Callback that is called when the text input is focused

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onSelectionChange</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputSelectionChangeEventData>) => void`}
</Code>

Callback that is called when the text input selection is changed.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onSubmitEditing</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputSubmitEditingEventData>) => void`}
</Code>

Callback that is called when the text input's submit button is pressed.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onTextInput</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputTextInputEventData>) => void`}
</Code>

Callback that is called on new text input with the argument
  `{ nativeEvent: { text, previousText, range: { start, end } } }`.

This prop requires multiline={true} to be set.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onScroll</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputScrollEventData>) => void`}
</Code>

Invoked on content scroll with
  `{ nativeEvent: { contentOffset: { x, y } } }`.

May also contain other properties from ScrollEvent but on Android contentSize is not provided for performance reasons.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onKeyPress</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`(e: NativeSyntheticEvent<TextInputKeyPressEventData>) => void`}
</Code>

Callback that is called when a key is pressed.
This will be called with
  `{ nativeEvent: { key: keyValue } }`
where keyValue is 'Enter' or 'Backspace' for respective keys and the typed-in character otherwise including ' ' for space.

Fires before onChange callbacks.
Note: on Android only the inputs from soft keyboard are handled, not the hardware keyboard inputs.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">placeholder</Code>** <Code fontSize="100" palette="primary">string</Code> 

The string that will be rendered before text input has been entered

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">returnKeyType</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"next"
  | "previous"
  | "default"
  | "none"
  | "search"
  | "done"
  | "go"
  | "send"
  | "google"
  | "join"
  | "route"
  | "yahoo"
  | "emergency-call"`}
</Code>

enum('default', 'go', 'google', 'join', 'next', 'route', 'search', 'send', 'yahoo', 'done', 'emergency-call')
Determines how the return key should look.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">secureTextEntry</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, the text input obscures the text entered so that sensitive text like passwords stay secure.
The default value is false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">selectTextOnFocus</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, all text will automatically be selected on focus

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">selection</Code>** <Code fontSize="100" palette="primary">{ start: number; end?: number; }</Code> 

The start and end of the text input's selection. Set start and end to
the same value to position the cursor.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">selectionColor</Code>** <Code fontSize="100" palette="primary">string | typeof OpaqueColorValue</Code> 

The highlight (and cursor on ios) color of the text input

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">style</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`false
  | TextStyle
  | RegisteredStyle<TextStyle>
  | RecursiveArray<false
  | TextStyle
  | RegisteredStyle<TextStyle>>`}
</Code>

Styles

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">textAlign</Code>** <Code fontSize="100" palette="primary">&#34;right&#34; | &#34;left&#34; | &#34;center&#34;</Code> 

Align the input text to the left, center, or right sides of the input field.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">testID</Code>** <Code fontSize="100" palette="primary">string</Code> 

Used to locate this view in end-to-end tests

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">inputAccessoryViewID</Code>** <Code fontSize="100" palette="primary">string</Code> 

Used to connect to an InputAccessoryView. Not part of react-natives documentation, but present in examples and
code.
See https://reactnative.dev/docs/inputaccessoryview for more information.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">value</Code>** <Code fontSize="100" palette="primary">string</Code> 

The value to show for the text input. TextInput is a controlled component,
which means the native value will be forced to match this value prop if provided.
For most uses this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same.
In addition to simply setting the same value, either set editable={false},
or set/update maxLength to prevent unwanted edits without flicker.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">maxFontSizeMultiplier</Code>** <Code fontSize="100" palette="primary">number</Code> 

Specifies largest possible scale a font can reach when allowFontScaling is enabled. Possible values:

- null/undefined (default): inherit from the parent node or the global default (0)
- 0: no max, ignore parent/global default
- >= 1: sets the maxFontSizeMultiplier of this node to this value

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">hitSlop</Code>** <Code fontSize="100" palette="primary">Insets</Code> 

This defines how far a touch event can start away from the view.
Typical interface guidelines recommend touch targets that are at least
30 - 40 points/density-independent pixels. If a Touchable view has
a height of 20 the touchable height can be extended to 40 with
hitSlop={{top: 10, bottom: 10, left: 0, right: 0}}
NOTE The touch area never extends past the parent view bounds and
the Z-index of sibling views always takes precedence if a touch
hits two overlapping views.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onLayout</Code>** <Code fontSize="100" palette="primary">(event: LayoutChangeEvent) =&#62; void</Code> 

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">pointerEvents</Code>** <Code fontSize="100" palette="primary">&#34;auto&#34; | &#34;none&#34; | &#34;box-none&#34; | &#34;box-only&#34;</Code> 

In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:

.box-none {
   pointer-events: none;
}
.box-none * {
   pointer-events: all;
}

box-only is the equivalent of

.box-only {
   pointer-events: all;
}
.box-only * {
   pointer-events: none;
}

But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes,
we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">removeClippedSubviews</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews,
most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound.
The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">nativeID</Code>** <Code fontSize="100" palette="primary">string</Code> 

Used to reference react managed views from native code.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">collapsable</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

Views that are only used to layout their children or otherwise don't draw anything
may be automatically removed from the native hierarchy as an optimization.
Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">needsOffscreenAlphaCompositing</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior.
The default (false) falls back to drawing the component and its children
with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value.
This default may be noticeable and undesired in the case where the View you are setting an opacity on
has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).

Rendering offscreen to preserve correct alpha behavior is extremely expensive
and hard to debug for non-native developers, which is why it is not turned on by default.
If you do need to enable this property for an animation,
consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame).
If that property is enabled, this View will be rendered off-screen once,
saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">renderToHardwareTextureAndroid</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

Whether this view should render itself (and all of its children) into a single hardware texture on the GPU.

On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale:
in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be
re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">focusable</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">shouldRasterizeIOS</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

Whether this view should be rendered as a bitmap before compositing.

On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children;
for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view
and quickly composite it during each frame.

Rasterization incurs an off-screen drawing pass and the bitmap consumes memory.
Test and measure when using this property.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">isTVSelectable</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

*(Apple TV only)* When set to true, this view will be focusable
and navigable using the Apple TV remote.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">hasTVPreferredFocus</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

*(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">tvParallaxProperties</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`{
  enabled?: boolean;
  shiftDistanceX?: number;
  shiftDistanceY?: number;
  tiltAngle?: number;
  magnification?: number;
  pressMagnification?: number;
  pressDuration?: number;
  pressDelay?: number;
}`}
</Code>

*(Apple TV only)* Object with properties to control Apple TV parallax effects.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">tvParallaxShiftDistanceX</Code>** <Code fontSize="100" palette="primary">number</Code> 

*(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">tvParallaxShiftDistanceY</Code>** <Code fontSize="100" palette="primary">number</Code> 

*(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 2.0.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">tvParallaxTiltAngle</Code>** <Code fontSize="100" palette="primary">number</Code> 

*(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 0.05.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">tvParallaxMagnification</Code>** <Code fontSize="100" palette="primary">number</Code> 

*(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus.  Defaults to 1.0.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onStartShouldSetResponder</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; boolean</Code> 

Does this view want to become responder on the start of a touch?

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onMoveShouldSetResponder</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; boolean</Code> 

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderEnd</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

If the View returns true and attempts to become the responder, one of the following will happen:

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderGrant</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

The View is now responding for touch events.
This is the time to highlight and show the user what is happening

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderReject</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

Something else is the responder right now and will not release it

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderMove</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

The user is moving their finger

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderRelease</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

Fired at the end of the touch, ie "touchUp"

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderStart</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderTerminationRequest</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; boolean</Code> 

Something else wants to become responder.
Should this view release the responder? Returning true allows release

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onResponderTerminate</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

The responder has been taken from the View.
Might be taken by other views after a call to onResponderTerminationRequest,
or might be taken by the OS without asking (happens with control center/ notification center on iOS)

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onStartShouldSetResponderCapture</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; boolean</Code> 

onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern,
where the deepest node is called first.
That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers.
This is desirable in most cases, because it makes sure all controls and buttons are usable.

However, sometimes a parent will want to make sure that it becomes responder.
This can be handled by using the capture phase.
Before the responder system bubbles up from the deepest component,
it will do a capture phase, firing on*ShouldSetResponderCapture.
So if a parent View wants to prevent the child from becoming responder on a touch start,
it should have a onStartShouldSetResponderCapture handler which returns true.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onMoveShouldSetResponderCapture</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; boolean</Code> 

onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern,
where the deepest node is called first.
That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers.
This is desirable in most cases, because it makes sure all controls and buttons are usable.

However, sometimes a parent will want to make sure that it becomes responder.
This can be handled by using the capture phase.
Before the responder system bubbles up from the deepest component,
it will do a capture phase, firing on*ShouldSetResponderCapture.
So if a parent View wants to prevent the child from becoming responder on a touch start,
it should have a onStartShouldSetResponderCapture handler which returns true.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onTouchStart</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onTouchMove</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onTouchEnd</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onTouchCancel</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onTouchEndCapture</Code>** <Code fontSize="100" palette="primary">(event: GestureResponderEvent) =&#62; void</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessible</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

When true, indicates that the view is an accessibility element.
By default, all the touchable elements are accessible.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityActions</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`readonly Readonly<{ name: string; label?: string; }>[]`}
</Code>

Provides an array of custom actions available for accessibility.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityLabel</Code>** <Code fontSize="100" palette="primary">string</Code> 

Overrides the text that's read by the screen reader when the user interacts with the element. By default, the
label is constructed by traversing all the children and accumulating all the Text nodes separated by space.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityRole</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"none"
  | "text"
  | "search"
  | "button"
  | "link"
  | "menu"
  | "alert"
  | "checkbox"
  | "radio"
  | "image"
  | "keyboardkey"
  | "adjustable"
  | "imagebutton"
  | "header"
  | "summary"
  | "combobox"
  | ... 10 more ...
  | "toolbar"`}
</Code>

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityState</Code>** <Code fontSize="100" palette="primary">AccessibilityState</Code> 

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityHint</Code>** <Code fontSize="100" palette="primary">string</Code> 

An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityValue</Code>** <Code fontSize="100" palette="primary">AccessibilityValue</Code> 

Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars,
it contains range information (minimum, current, and maximum).

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onAccessibilityAction</Code>** <Code fontSize="100" palette="primary">(event: AccessibilityActionEvent) =&#62; void</Code> 

When `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityLiveRegion</Code>** <Code fontSize="100" palette="primary">&#34;none&#34; | &#34;assertive&#34; | &#34;polite&#34;</Code> 

Indicates to accessibility services whether the user should be notified when this view changes.
Works for Android API >= 19 only.
See http://developer.android.com/reference/android/view/View.html#attr_android:accessibilityLiveRegion for references.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">importantForAccessibility</Code>** <Code fontSize="100" palette="primary">&#34;auto&#34; | &#34;yes&#34; | &#34;no&#34; | &#34;no-hide-descendants&#34;</Code> 

Controls how view is important for accessibility which is if it fires accessibility events
and if it is reported to accessibility services that query the screen.
Works for Android only. See http://developer.android.com/reference/android/R.attr.html#importantForAccessibility for references.

Possible values:
      'auto' - The system determines whether the view is important for accessibility - default (recommended).
      'yes' - The view is important for accessibility.
      'no' - The view is not important for accessibility.
      'no-hide-descendants' - The view is not important for accessibility, nor are any of its descendant views.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityElementsHidden</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

A Boolean value indicating whether the accessibility elements contained within this accessibility element
are hidden to the screen reader.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityViewIsModal</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onAccessibilityEscape</Code>** <Code fontSize="100" palette="primary">() =&#62; void</Code> 

When accessibile is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onAccessibilityTap</Code>** <Code fontSize="100" palette="primary">() =&#62; void</Code> 

When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">onMagicTap</Code>** <Code fontSize="100" palette="primary">() =&#62; void</Code> 

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">accessibilityIgnoresInvertColors</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">clearButtonMode</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"always"
  | "never"
  | "while-editing"
  | "unless-editing"`}
</Code>

enum('never', 'while-editing', 'unless-editing', 'always')
When the clear button should appear on the right side of the text view

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">clearTextOnFocus</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, clears the text field automatically when editing begins

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">dataDetectorTypes</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"none"
  | "all"
  | "link"
  | "phoneNumber"
  | "address"
  | "calendarEvent"
  | DataDetectorTypes[]`}
</Code>

Determines the types of data converted to clickable URLs in the text input.
Only valid if `multiline={true}` and `editable={false}`.
By default no data types are detected.

You can provide one type or an array of many types.

Possible values for `dataDetectorTypes` are:

- `'phoneNumber'`
- `'link'`
- `'address'`
- `'calendarEvent'`
- `'none'`
- `'all'`

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">enablesReturnKeyAutomatically</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If true, the keyboard disables the return key when there is no text and automatically enables it when there is text.
The default value is false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">keyboardAppearance</Code>** <Code fontSize="100" palette="primary">&#34;default&#34; | &#34;light&#34; | &#34;dark&#34;</Code> 

Determines the color of the keyboard.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">passwordRules</Code>** <Code fontSize="100" palette="primary">string</Code> 

Provide rules for your password.
For example, say you want to require a password with at least eight characters consisting of a mix of uppercase and lowercase letters, at least one number, and at most two consecutive characters.
"required: upper; required: lower; required: digit; max-consecutive: 2; minlength: 8;"

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">rejectResponderTermination</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If `true`, allows TextInput to pass touch events to the parent component.
This allows components to be swipeable from the TextInput on iOS,
as is the case on Android by default.
If `false`, TextInput always asks to handle the input (except when disabled).

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">selectionState</Code>** <Code fontSize="100" palette="primary">DocumentSelectionState</Code> 

See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">spellCheck</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If false, disables spell-check style (i.e. red underlines). The default value is inherited from autoCorrect

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">textContentType</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"none"
  | "name"
  | "location"
  | "URL"
  | "addressCity"
  | "addressCityAndState"
  | "addressState"
  | "countryName"
  | "creditCardNumber"
  | "emailAddress"
  | "familyName"
  | "fullStreetAddress"
  | ... 15 more ...
  | "oneTimeCode"`}
</Code>

Give the keyboard and the system information about the expected
semantic meaning for the content that users enter.

For iOS 11+ you can set `textContentType` to `username` or `password` to
enable autofill of login details from the device keychain.

For iOS 12+ `newPassword` can be used to indicate a new password input the
user may want to save in the keychain, and `oneTimeCode` can be used to indicate
that a field can be autofilled by a code arriving in an SMS.

To disable autofill, set textContentType to `none`.

Possible values for `textContentType` are:

  - `'none'`
  - `'URL'`
  - `'addressCity'`
  - `'addressCityAndState'`
  - `'addressState'`
  - `'countryName'`
  - `'creditCardNumber'`
  - `'emailAddress'`
  - `'familyName'`
  - `'fullStreetAddress'`
  - `'givenName'`
  - `'jobTitle'`
  - `'location'`
  - `'middleName'`
  - `'name'`
  - `'namePrefix'`
  - `'nameSuffix'`
  - `'nickname'`
  - `'organizationName'`
  - `'postalCode'`
  - `'streetAddressLine1'`
  - `'streetAddressLine2'`
  - `'sublocality'`
  - `'telephoneNumber'`
  - `'username'`
  - `'password'`
  - `'newPassword'`
  - `'oneTimeCode'`

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">scrollEnabled</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

If false, scrolling of the text view will be disabled. The default value is true. Only works with multiline={true}

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">autoCompleteType</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"off"
  | "tel"
  | "email"
  | "name"
  | "username"
  | "password"
  | "cc-csc"
  | "cc-exp"
  | "cc-exp-month"
  | "cc-exp-year"
  | "cc-number"
  | "postal-code"
  | "street-address"`}
</Code>

Determines which content to suggest on auto complete, e.g.`username`.
To disable auto complete, use `off`.

*Android Only*

The following values work on Android only:

- `username`
- `password`
- `email`
- `name`
- `tel`
- `street-address`
- `postal-code`
- `cc-number`
- `cc-csc`
- `cc-exp`
- `cc-exp-month`
- `cc-exp-year`
- `off`

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">importantForAutofill</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`"auto"
  | "yes"
  | "no"
  | "noExcludeDescendants"
  | "yesExcludeDescendants"`}
</Code>

Determines whether the individual fields in your app should be included in a
view structure for autofill purposes on Android API Level 26+. Defaults to auto.
To disable auto complete, use `off`.

*Android Only*

The following values work on Android only:

- `auto` - let Android decide
- `no` - not important for autofill
- `noExcludeDescendants` - this view and its children aren't important for autofill
- `yes` - is important for autofill
- `yesExcludeDescendants` - this view is important for autofill but its children aren't

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">disableFullscreenUI</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

When false, if there is a small amount of space available around a text input (e.g. landscape orientation on a phone),
   the OS may choose to have the user edit the text inside of a full screen text input mode.
When true, this feature is disabled and users will always edit the text directly inside of the text input.
Defaults to false.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">inlineImageLeft</Code>** <Code fontSize="100" palette="primary">string</Code> 

If defined, the provided image resource will be rendered on the left.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">inlineImagePadding</Code>** <Code fontSize="100" palette="primary">number</Code> 

Padding between the inline image, if any, and the text input itself.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">numberOfLines</Code>** <Code fontSize="100" palette="primary">number</Code> 

Sets the number of lines for a TextInput.
Use it with multiline set to true to be able to fill the lines.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">returnKeyLabel</Code>** <Code fontSize="100" palette="primary">string</Code> 

Sets the return key to the label. Use it instead of `returnKeyType`.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">textBreakStrategy</Code>** <Code fontSize="100" palette="primary">&#34;simple&#34; | &#34;highQuality&#34; | &#34;balanced&#34;</Code> 

Set text break strategy on Android API Level 23+, possible values are simple, highQuality, balanced
The default value is simple.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">underlineColorAndroid</Code>** <Code fontSize="100" palette="primary">string | typeof OpaqueColorValue</Code> 

The color of the textInput underline.

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">textAlignVertical</Code>** <Code fontSize="100" palette="primary">&#34;auto&#34; | &#34;top&#34; | &#34;bottom&#34; | &#34;center&#34;</Code> 

Vertically align text when `multiline` is set to true

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">showSoftInputOnFocus</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

When false, it will prevent the soft keyboard from showing when the field is focused. The default value is true

<Divider marginTop="major-2" marginBottom="major-2" />

</details>
            

<details><Box use="summary" marginBottom="major-2">Inherits <strong><code>Box</code></strong> props</Box>

**<Code fontSize="150" marginRight="major-1">animated</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">children</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`string
  | number
  | boolean
  | {}
  | ReactElement<any, string
  | ((props: any) => ReactElement<any, string
  | ...
  | (new (props: any) => Component<any, any, any>)>)
  | (new (props: any) => Component<...>)>
  | ReactNodeArray
  | ReactPortal
  | ((props: BoxProps) => ReactNode)`}
</Code>

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">alignX</Code>** <Code fontSize="100" palette="primary">&#34;right&#34; | &#34;left&#34; | &#34;center&#34;</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">alignY</Code>** <Code fontSize="100" palette="primary">&#34;top&#34; | &#34;bottom&#34; | &#34;center&#34;</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">altitude</Code>** <Code fontSize="100" palette="primary">string</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">variant</Code>** <Code fontSize="100" palette="primary">string</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">colorMode</Code>** <Code fontSize="100" palette="primary">string</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">disabled</Code>** <Code fontSize="100" palette="primary">boolean</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">overrides</Code>**  

<Code isBlock palette="primary" fontSize="150" padding="minor-1" marginBottom="major-2">
{`{
  altitudes?: AltitudesThemeConfig;
  borders?: BordersThemeConfig;
  borderRadii?: BorderRadiiThemeConfig;
  breakpoints?: {
    ...
  }; ... 39 more ...;
  ToastManager?: ToastManagerThemeConfig;
}`}
</Code>

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">elementRef</Code>** <Code fontSize="100" palette="primary">((instance: any) =&#62; void) | RefObject&#60;any&#62;</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

**<Code fontSize="150" marginRight="major-1">themeKey</Code>** <Code fontSize="100" palette="primary">string</Code> 

<Divider marginTop="major-2" marginBottom="major-2" />

</details>
            

<details><Box use="summary" marginBottom="major-2">Inherits <strong><a href="https://reactnative.dev/docs/view">React Native's <code>View</code></a></strong> props</Box>

</details>
            

## Theming

### Input

 <Theme
  component={'Input'}
  platform="native"
  overrides={[
    'Input.styles.base',
    { key: 'Input.styles.disabled', props: { disabled: true } },
    { key: 'Input.styles.sizes.small', props: { size: 'small' } },
    { key: 'Input.styles.sizes.default', props: { size: 'default' } },
    { key: 'Input.styles.sizes.medium', props: { size: 'medium' } },
    { key: 'Input.styles.sizes.large', props: { size: 'large' } },
    { key: 'Input.LabelWrapper.styles.base', props: { label: 'Username' } },
    { key: 'Input.Label.styles.base', props: { label: 'Username' } }
  ]} />
